home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 May / macformat-024.iso / Shareware City / Comms / Chat 2.1Pre6 Release / Chat Documentation < prev    next >
Encoding:
Text File  |  1995-01-24  |  9.8 KB  |  272 lines  |  [TEXT/R*ch]
  1. NOTE: This documentation is really out of date, alot of commands are not
  2. described in here. Look at /HELP and \HELP while connected to the chat
  3. room for more information.
  4.  
  5. =========
  6. Contents:
  7. =========
  8.  
  9.     * What is Chat?
  10.     * Shareware Fees/Information:
  11.     * Where can I get the latest version:
  12.     * Restrictions/Requirements/Fine Print/Etc.
  13.     * What is needed to run Chat?
  14.     * How do I connect to Chat?
  15.     * User Command Summary:
  16.     * Administrator Command Summary:
  17.     * Customizing Chat:
  18.     * About the Author:
  19.     * Acknowlegments:
  20.     
  21.     Also, enclosed files:
  22.     * Sample Session - Sample Login and Use of the Chat Room
  23.     * Chat Release Information - Information about each version
  24.     * Chat FAQ - Frequently Asked Questions
  25.  
  26. =============
  27. What is Chat?
  28. =============
  29.  
  30. Chat is a application that lets a Macintosh with MacTCP serve 
  31. as a simple internet chat room.  Once Chat is running on your mac, multiple 
  32. people can Telnet to your mac and have online discussions.
  33.   
  34. The user portion of Chat has no macintosh user interface, the only way to use 
  35. it is by telneting to your mac. However, the adminstrator can perform most of
  36. the tasks necessary through the macintosh interface.
  37.  
  38. Chat can support as many connections as it has memory for - and MacTCP will 
  39. allow.
  40.  
  41. ===========================
  42. Shareware Fees/Information:
  43. ===========================
  44.  
  45. Chat is what is Shareware ($10 per machine for up to 5 machines). This only 
  46. applies to  the machine that chat is actually running on, you can have as many
  47. connections as you want. (The more the better!) If you are a student or
  48. something, and  legitimately cannot afford to send me the shareware fee, send me
  49. a Postcard from your home/college/current town instead. 
  50.  
  51. The site license, if you want to run chat on multiple machines is $50.
  52.  
  53. If you work for a software company, and cannot/do not want to pay the shareware 
  54. fee, I would accept a sample copy of a product that you produce.
  55.  
  56. I would appreciate at the very least an email message from anyone who uses chat,
  57. or has done anything interesting with the source.
  58.  
  59. See "About the Author" for Email Address and Postal Address.
  60.  
  61.  
  62. ===================================
  63. Where can I get the latest version:
  64. ===================================
  65.  
  66. Chat can be ftp'd from most of the major archive sites, include any Info-Mac
  67. mirror. You can also always get the latest version from pluto.cc.umr.edu
  68. in the /pub/chat directory. The source to Chat is available in that directory
  69. as well.
  70.  
  71. For World Wide Web users, the chat home page is:
  72.     http://pluto.cc.umr.edu/chat.html
  73.     
  74.  
  75. =========================================
  76. Restrictions/Requirements/Fine Print/Etc.
  77. =========================================
  78.  
  79. The Chat application may be uploaded to any online service, provided that the 
  80. entire archive is uploaded and no changes are made to it. The source to Chat 
  81. may not be uploaded to any other FTP site or to any online service without
  82. contacting me first, currently the only place you can get the source is from 
  83. my ftp site (pluto.cc.umr.edu).
  84.  
  85. If you want to include chat on any mass distribution medium, such as a CD-Rom, 
  86. or want to include it with any other applications distributed with a book for 
  87. example; contact me first, I will make sure that you have the latest version. 
  88. In addition, I would appreciated, though I do not require, a sample copy of the
  89. CD/book/etc.
  90.  
  91. If you want to redistribute the source to chat with Changes or as a new program,
  92. please contact me via email first. I would like to take a look at the application.
  93. Also, any redistributed application or source must aknowledge both me, and Peter 
  94. Lewis in the source, and the About Box.
  95.  
  96. ===========================
  97. What is needed to run Chat?
  98. ===========================
  99.  
  100. You must have MacTCP 1.1 or newer to run Chat.
  101.  
  102. Currently, as of version 2.1, Chat requires System 7. If there is interest in
  103. maintaining support for System 6, I will put that support in. Email me if
  104. you want this done.
  105.  
  106.  
  107. =========================
  108. How do I connect to Chat?
  109. =========================
  110.  
  111. To connect to the chat room, you need a program which supports telnet connections. 
  112.  
  113. Programs which support telnet connections: 
  114.  
  115. IMPORTANT: The default PORT number for chat as distributed is 23 - the
  116.     default telnet port. So, when connecting to the chat room with
  117.     telnet or another application, you do not need to specify a port
  118.     number, or if you do specify one, it should be 23.
  119.  
  120. Mac:
  121.    NCSA Telnet   -   Open Connection in File Menu
  122.    MUDDweller    -   New, TCP/IP Address in Configure Menu, Open Connection
  123.    tn3270        -   
  124.  
  125. Unix:
  126.    Telnet        -   'telnet address' or 'telnet address port'
  127.  
  128. VMS:
  129.    Telnet        -   'telnet address' or 'telnet address /port=port'
  130.    
  131. Once you are connected, simply fill in the requested information on screen. 
  132. After the initial login screen, anything you type will be sent to the screen. If
  133. you type a line that begins with "/" or "\", it will be treated as a user or 
  134. administrator command, respectively. 
  135.  
  136. Both user commands and administrator commands are documented next.
  137.  
  138.  
  139. =====================
  140. User Command Summary:
  141. =====================
  142.  
  143. The long form of the command name is listed here, see /HELP in the Chat room 
  144. for information on the abbreviated/short forms.
  145.  
  146. Command:   Syntax:                        Info:
  147. =================================================================================
  148. /HELP            /HELP                            Displays user command help
  149.                 /anything that's not a valid command
  150.  
  151. /ME        /ME                            Displays information about yourself
  152.  
  153. /QUIT            /QUIT                            Exits the chat room.
  154.  
  155. /LIST            /LIST                            Lists users on current channel
  156.  
  157. /LISTALL    /LISTALL                    Lists users on all channels
  158.  
  159. /DO           /DO text                    Sends text as an action (without the colon).
  160.  
  161. /YELL            /YELL text                    Sends text to all channels.
  162.  
  163. /PAGE            /PAGE user                    Pages 'user' to current channel.
  164.  
  165. /CHANNEL    /CHANNEL                    Lists available channels.
  166.                 /CHANNEL channel        Changes to channel 'channel'.
  167.  
  168. /WHISPER   /WHISPER user text        Sends 'text' to user 'user' only.
  169.  
  170. /SET            /SET var value            Sets the value of a variable
  171.                 /SET                             Lists available user variables.
  172.                 /SET NAME name            Changes your name to 'name'.
  173.                 /SET SUBJECT    text        Changes the subject of the current channel.
  174.                 /SET ECHO On/Off        Sets whether you see your own messages.
  175.                 
  176. /RECENT    /RECENT                        Lists recent users of the chat room.
  177.  
  178. /ROLL        /ROLL #d%                    Rolls #, % sided dice.
  179.                 /ROLL                            Rolls one twenty sided die.
  180.             
  181.  
  182. ==============================
  183. Administrator Command Summary:
  184. ==============================
  185.  
  186. In all the following commands, 'pw' is the adminstrators password. The chat room
  187. will display admin command help if the password is incorrect or missing.
  188.  
  189. Command:  Syntax:                  Info:
  190. =================================================================================
  191. \HELP     \HELP                    Displays administrative command help
  192.           \anything that's not a valid command
  193.                 
  194. \KILL     \KILL pw user            Kicks a user out of the chat room.
  195.  
  196. \QUITNOW  \QUITNOW pw              Quits the chat room application.
  197.  
  198. \RESTART  \RESTART pw              Kicks everyone off chat room, and restarts.
  199.  
  200. \HIDE     \HIDE pw                 Sets yourself to not show in /LIST and /LISTALL
  201.  
  202. \UNHIDE   \UNHIDE pw               Sets yourself to show in /LIST and /LISTALL
  203.  
  204. \LISTALL  \LISTALL pw              Lists all users, include hidden ones.
  205.  
  206. \SHOW     \SHOW pw                 Displays current administrator variable settings
  207.  
  208. \INFO     \INFO pw                 Displays information on chat room status
  209.  
  210. \SET      \SET pw var value        Sets the value of an administrator variable.
  211.         \SET pw                  Lists administrative variables.
  212.         \SET pw LOGINS On/Off    Allow user logins 
  213.         \SET pw YELLS On/Off     Allow /YELL command 
  214.         \SET pw WHISPERS On/Off  Allow /WHISPER command 
  215.         \SET pw PASSWORDS On/Off Require password at login 
  216.         \SET pw BEEP On/Off      Beep on Login
  217.         \SET pw PROMPT On/Off    Prompt for channel at login
  218.         \SET pw SUBJECT text     Set subject of current channel
  219.         \SET pw USERSUB On/Off   Allow users to change subjects
  220.  
  221. =====================
  222. Customizing Chat:
  223. =====================
  224.  
  225. Almost all of the strings and settings for chat are stored in the resource fork.
  226.  
  227. The strings can be edited to suit your particular environment, however, do not 
  228. add or remove any strings, as the program will not be able to find them. The 
  229. only exception to this are the Chat Log Filenames, Chat Channels, Chat 
  230. Channel Subjects, User Passwords, and Admin Passwords string resources, you 
  231. can add to these to add more channels, etc. Remember to add to all three channel 
  232. string resources at the same time (Log File, Channel Name, and Subject).
  233.  
  234. The 'CPrf' resource holds the default preferences for the Chat Room.
  235.  
  236.  
  237. =================
  238. About the Author:
  239. =================
  240.  
  241. I am a Computer Science major at the University of Missouri - Rolla, 
  242. originally from Connecticut. I ran across chat while looking at TCP/IP 
  243. applications for the Mac, and decided to customize it for my own purposes.
  244. It has evolved greatly since then, and is used by people all across the world.
  245.  
  246. I can be reached via email on the internet at "nneul@umr.edu". 
  247.  
  248. My postal address:
  249.  
  250. Nathan Neulinger
  251. 53 Sleepy Hollow Lane
  252. Stamford, CT  06907-1734
  253. USA
  254.  
  255. ===============
  256. Acknowlegments:
  257. ===============
  258.  
  259. Thanks to Peter Lewis (peter.lewis@info.curtin.edu.au) for the original (1.1) 
  260. version of Chat, and for much help in getting Chat to where it is today.
  261.  
  262. Thanks to Erich (?) for the new and improved die rolling routines. For those 
  263. who are interested, take a look at his re-release of chat, called NetRPG, for
  264. playing Role Playing Games over the internet.
  265.  
  266. Thanks to Jon Stevens (root@dolphin.csudh.edu) for extensive testing, and 
  267. comments on how to improve chat.
  268.  
  269. Thanks to everyone who has written me about Chat with comments, suggestions, and
  270. anything else for that matter. It is your suggestions and wishes that have
  271. given me the directions for how to improve chat. Keep 'em coming.
  272.